docs(sp-truncated): updated sp-truncated pattern #5839

Rajdeepc · 2025-10-28T13:00:49Z

Description

Comprehensive documentation rewrite for sp-truncated with full API reference, accessibility guidelines, usage patterns, and practical examples across multiple component contexts.

Added sp-truncated to bundle/elements.ts to ensure proper component registration and CSS rendering in documentation demo blocks.

Motivation and context

Related issue(s)

fixes SWC-431

Screenshots (if appropriate)

Author's checklist

I have read the CONTRIBUTING and PULL_REQUESTS documents.
I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
I have added automated tests to cover my changes.
I have included a well-written changeset if my change needs to be published.
I have included updated documentation if my change required it.

Reviewer's checklist

Includes a Github Issue with appropriate flag or Jira ticket number without a link
Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
Automated tests cover all use cases and follow best practices for writing
Validated on all supported browsers
All VRTs are approved before the author can update Golden Hash

Manual review test cases

Descriptive Test Statement
1. Go here
2. Do this action
3. Expect this result
Descriptive Test Statement
1. Go here
2. Do this action
3. Expect this result

Device review

Did it pass in Desktop?
Did it pass in (emulated) Mobile?
Did it pass in (emulated) iPad?

changeset-bot · 2025-10-28T13:00:53Z

⚠️ No Changeset found

Latest commit: caefec6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2025-10-28T13:02:27Z

📚 Branch Preview

🔍 Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-5839

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

github-actions · 2025-10-28T13:05:57Z

Tachometer results

Currently, no packages are changed by this PR...

coveralls · 2025-10-28T13:10:49Z

Pull Request Test Coverage Report for Build 18939955006

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 97.964%

Totals
Change from base Build 18885025935:	0.0%
Covered Lines:	34259
Relevant Lines:	34788

💛 - Coveralls

Rajdeepc · 2025-10-30T12:03:17Z

Known issue: sp-tooltip is getting cut off due to max-width constraint for long words. Will be tacked in SWC-1331

TarunAdobe

Looks good. I only have a couple of questions/suggestions.
Also I noticed that the API tab for truncated is all empty and I wonder if that's an easy fix or should we address that separately?

1st-gen/tools/bundle/elements.ts

1st-gen/tools/truncated/README.md

Rajdeepc · 2025-11-10T07:20:59Z

Looks good. I only have a couple of questions/suggestions. Also I noticed that the API tab for truncated is all empty and I wonder if that's an easy fix or should we address that separately?

Yes in our component generation template we are explicitly checking for public properties to show in the API tab. For me this is too restrictive. When there is no modifier, it infers as privacy-> undefined. We can change the logic to place everything which is not private. Let's take this in a separate PR.

return member?.privacy !== 'private';

blunteshwar

LGTM!!

nikkimk

Thanks for adding so many examples. In doing so I was able to test this and uncover more questions and issues. Take a look at what I have uncovered and decide which observations should be filed as issues, and which issues should be noted as warnings in this documentation.

nikkimk · 2025-11-10T14:31:44Z

1st-gen/tools/truncated/README.md

+    <sp-truncated>
+        ThisIsAVeryLongWordWithoutAnySpacesThatShouldBeTruncated
+    </sp-truncated>


This example isn't working on the docs page as the tooltip does not show the entire content.

nikkimk · 2025-11-10T14:37:22Z

1st-gen/tools/truncated/README.md

+    <sp-truncated>
+        This is the inline content that gets truncated
+        <span slot="overflow">
+            This custom overflow content will appear in the tooltip with any
+            additional information or formatting you need.
+        </span>
+    </sp-truncated>


I noticed in the examples that only This is the inline content that gets is displayed and in the tooltip This custom overflow content will appear in the tooltip with any additional information or formatting you need gets displayed, which means, neither the truncated text nor the tooltip show the word truncated (ironic).

Should everything before the overflow be displayed, i.e This is the inline content that gets truncated? Or is this working as designed?

If the latter is true, we should warn consumers that setting the overflow might cause some words to be neither visible in the truncated line nor the tooltip.

why would we even include content in an overflowed slot that isnt the actual text? im needing a use case to understand how and when this should be used in product. its feeling like a dark UX pattern.

nikkimk · 2025-11-10T14:39:21Z

1st-gen/tools/truncated/README.md

+
+#### Custom success message
+
+When text is copied to the clipboard, a custom success message can be displayed:


I tried copying the text, and while I got the success message, when I pasted I noticed the copy wasn't the full text.

I didn't realize that the act of clicking the div would copy the whole thing.

again this feels like a dark pattern, does this mean that anything wrapped in a truncated is keyboard navigable? how would this functionality work for now mouse users? what visual queue are we providing that its copyable?

nikkimk · 2025-11-10T14:40:49Z

1st-gen/tools/truncated/README.md

+<div
+    style="width: 250px; border: 1px solid var(--spectrum-gray-300); padding: 8px; border-radius: 4px;"
+>
+    <sp-truncated>[email protected]</sp-truncated>
+</div>


Should this be a field instead of a div? Field labels should only be used with interactive elements, such as form fields.

nikkimk · 2025-11-10T14:41:32Z

1st-gen/tools/truncated/README.md

+                <sp-truncated>
+                    very.long.username.that.exceeds.the.available.width
+                </sp-truncated>


The tooltip here is also not displaying the full content.

nikkimk · 2025-11-10T14:52:06Z

1st-gen/tools/truncated/README.md

+**Important accessibility note:** The click handler on the truncated text does not include keyboard event handlers (`/* eslint-disable lit-a11y/click-events-have-key-events */`). This is a known limitation. Users who rely on keyboard navigation will need to use the tooltip hover interaction to view the full content, but cannot copy it via keyboard alone.
+
+#### Screen readers
+
+Screen readers will announce the visible truncated text. When the tooltip appears on hover, screen readers will announce the full content if it differs from the visible text.
+
+For custom overflow content, ensure that the slotted content is semantically meaningful and properly structured for screen readers.


Since the sp-truncated does not receive keyboard focus, a keyboard user will never be able to tooltip hover.

Screenreader users--who are very often but not always keyboard users---will hear the full content without the tooltip.

Not all keyboard users are screenreader users, so this is an accessibility bug.

There is a very interesting thread in the a11y channel on slack specifically about truncation and how its actually an inaccessible pattern as a whole. we might want to bring this up in one of our team meetings

caseyisonit · 2025-11-10T18:08:42Z

Looks good. I only have a couple of questions/suggestions. Also I noticed that the API tab for truncated is all empty and I wonder if that's an easy fix or should we address that separately?

Yes in our component generation template we are explicitly checking for public properties to show in the API tab. For me this is too restrictive. When there is no modifier, it infers as privacy-> undefined. We can change the logic to place everything which is not private. Let's take this in a separate PR.
return member?.privacy !== 'private';

I believe we should require every property has a modifier instead of loosing the API table generation. we should be intentional about our properties

caseyisonit · 2025-11-10T18:13:00Z

I have major accessibility concerns with this component that we need to discuss as a team.

For this specific docs PR:

I am seeing correct copy to clipboard.
I am seeing INCORRECT rendering of tooltip container on several examples when hovering.

caseyisonit

left comments

TarunAdobe · 2025-11-11T06:33:25Z

Looks good. I only have a couple of questions/suggestions. Also I noticed that the API tab for truncated is all empty and I wonder if that's an easy fix or should we address that separately?

Yes in our component generation template we are explicitly checking for public properties to show in the API tab. For me this is too restrictive. When there is no modifier, it infers as privacy-> undefined. We can change the logic to place everything which is not private. Let's take this in a separate PR.
return member?.privacy !== 'private';

Yup! You got this right. I did update it in my last PR so it should be fine now (since this is up to date with main). Everything which is not private should be in the API table for now.

docs: updated sp-truncated pattern

78be3f6

Rajdeepc self-assigned this Oct 28, 2025

Rajdeepc requested a review from a team as a code owner October 28, 2025 13:00

Rajdeepc added a11y Issues or PRs related to accessibility Documentation Issues or PRs involving changes to documentation or documentation website Status: Ready for review PR ready for review or re-review. labels Oct 28, 2025

Rajdeepc marked this pull request as draft October 28, 2025 13:09

Rajdeepc added Status: WIP PR is a work in progress or draft and removed Status: Ready for review PR ready for review or re-review. labels Oct 28, 2025

chore: updated guidelines text

69e086b

Rajdeepc marked this pull request as ready for review October 30, 2025 12:03

Merge branch 'main' into rajdeep/truncated-docs

1fa7876

Rajdeepc added Status: Ready for review PR ready for review or re-review. and removed Status: WIP PR is a work in progress or draft labels Oct 30, 2025

Rajdeep Chandra added 2 commits November 6, 2025 12:24

Merge branch 'main' into rajdeep/truncated-docs

b1e52d9

Merge branch 'main' into rajdeep/truncated-docs

ddb5353

Rajdeepc requested review from marissahuysentruyt, nikkimk and rise-erpelding November 6, 2025 17:50

Merge branch 'main' into rajdeep/truncated-docs

a1357d1

TarunAdobe requested changes Nov 10, 2025

View reviewed changes

1st-gen/tools/bundle/elements.ts Show resolved Hide resolved

1st-gen/tools/truncated/README.md Show resolved Hide resolved

blunteshwar requested changes Nov 10, 2025

View reviewed changes

1st-gen/tools/truncated/README.md Outdated Show resolved Hide resolved

chore: updated text to show custom message

096681d

Rajdeepc requested review from TarunAdobe and blunteshwar November 10, 2025 07:03

Merge branch 'main' into rajdeep/truncated-docs

caefec6

blunteshwar approved these changes Nov 10, 2025

View reviewed changes

nikkimk requested changes Nov 10, 2025

View reviewed changes

caseyisonit requested changes Nov 10, 2025

View reviewed changes


		#### Custom success message

		When text is copied to the clipboard, a custom success message can be displayed:

docs(sp-truncated): updated sp-truncated pattern #5839

Are you sure you want to change the base?

docs(sp-truncated): updated sp-truncated pattern #5839

Uh oh!

Conversation

Rajdeepc commented Oct 28, 2025

Description

Motivation and context

Related issue(s)

Screenshots (if appropriate)

Author's checklist

Reviewer's checklist

Manual review test cases

Device review

Uh oh!

changeset-bot bot commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions bot commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Branch Preview

🔍 Visual Regression Test Results

Uh oh!

github-actions bot commented Oct 28, 2025

Tachometer results

Uh oh!

coveralls commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 18939955006

Details

💛 - Coveralls

Uh oh!

Rajdeepc commented Oct 30, 2025

Uh oh!

TarunAdobe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Rajdeepc commented Nov 10, 2025

Uh oh!

blunteshwar left a comment

Choose a reason for hiding this comment

Uh oh!

nikkimk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

caseyisonit Nov 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

caseyisonit commented Nov 10, 2025

Uh oh!

caseyisonit commented Nov 10, 2025

Uh oh!

caseyisonit left a comment

Choose a reason for hiding this comment

Uh oh!

TarunAdobe commented Nov 11, 2025

Uh oh!

Reviewers

Assignees

changeset-bot bot commented Oct 28, 2025 •

edited

Loading

github-actions bot commented Oct 28, 2025 •

edited

Loading

coveralls commented Oct 28, 2025 •

edited

Loading

caseyisonit Nov 10, 2025 •

edited

Loading